home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / sfame095.zip / SFAME.DOC < prev    next >
Text File  |  1995-11-22  |  79KB  |  1,505 lines

  1.  
  2.                   ╔════════════════════════════════════════╗
  3.                   ║                                        ║
  4.                   ║         ╓─┐ ╥──┐ ╓──┐ ╓─╥─┐ ╥──┐       ║
  5.                   ║         ╙─┐ ╟─   ╟──┤ ║ ║ │ ╟─         ║
  6.                   ║        ╙──┘ ╨    ╨  ┴ ╨ ╨ ┴ ╨──┘       ║
  7.                   ║                   v.95                 ║
  8.                   ║     SPITFIRE ADVANCED MESSAGE EDITOR   ║
  9.                   ║                                        ║
  10.                   ║       Copyright By Richard Lemaster    ║
  11.                   ║             Over The Line BBS          ║
  12.                   ║              (918) 250-0542            ║
  13.                   ║                                        ║
  14.                   ╚════════════════════════════════════════╝
  15.  
  16.  
  17.   INTRODUCTION
  18.   ────────────
  19.  
  20.   SFAME is a utility written to greatly enhance the default SPITFIRE
  21.   Message Menu.  The SPITFIRE Advanced Message Editor interfaces closely
  22.   with SPITFIRE's message base but also provides the BBS caller with many
  23.   options not directly available in SPITFIRE.  Some of SFAME's advanced
  24.   features include a full-screen message editor, grouping of message
  25.   conferences, caller configuration options, message scripts, file attaches
  26.   to messages and full alias support.
  27.  
  28.  
  29.   QUICK SETUP
  30.   ───────────
  31.  
  32.   Create a directory for SFAME and unzip the SFAME archive in this
  33.   directory. Next, type CONFIG to setup the default SFAME files. You
  34.   will be asked if you want to create a SFAME.CFG file. Choose Y to
  35.   continue. You will then be asked if you want to create a GROUPS.DAT
  36.   file. Choose Y to continue. SFAME is now setup and ready to use. To
  37.   exit CONFIG, choose Q from the main menu. You can then type SFAME
  38.   from the command line.
  39.  
  40.  
  41.   CONFIGURATION
  42.   ─────────────
  43.  
  44.   Begin by creating a directory which will be used by SFAME. For the
  45.   purpose of explanation, our examples, will refer to a directory named
  46.   SFAME located on the C: drive.
  47.  
  48.   Next, unzip the SFAME archive file into the C:\SFAME directory.
  49.   This will place the files included in the distribution package into this
  50.   directory.  To simplify the configuration process, SFAME includes a file,
  51.   CONFIG.EXE that can be used to define SFAME's operational values.
  52.   Simply type CONFIG from the DOS prompt while in the SFAME directory. You
  53.   will then be asked if you would like to create a SFAME.CFG file. Choose
  54.   Yes to continue. You will then be asked if you would like to create the
  55.   GROUPS.DAT file. Choose Yes to continue. You will then see the main
  56.   config menu. SFAME is now ready to use. From the Main Menu Choose
  57.   option 1 to edit the default SFAME settings for your BBS. The next
  58.   screen will display the settings you can change by selecting the
  59.   letter for an option. The options available are:
  60.  
  61.   <A> Script Directory - This is the directory where your scripts are
  62.                          placed. Scripts should be placed in a separate
  63.                          directory to keep the SFAME home directory clean.
  64.                          Scripts will be be explained later.
  65.  
  66.   <B> Use Scripts      - Set this to TRUE if you would like scripts
  67.                          available in the message editor. Scripts will
  68.                          be explained later. You might want to read more
  69.                          about scripts before setting this option.
  70.  
  71.   <C> Main Menu Logoff - Setting this to TRUE will allow callers to
  72.                          log-off from the SFAME main menu. It will
  73.                          display a Goodbye.bbs/clr screen if found in
  74.                          your SPITFIRE display directory.
  75.  
  76.   <D> Main Menu Extension Name - This is the name displayed on the SFAME
  77.                          main menu for the main menu extension. When the
  78.                          extension option is choosen, SFAME will first
  79.                          check for a NODE#.BAT file to execute. The #
  80.                          is the node number. NODE2.BAT will be run if
  81.                          the caller is logged on node 2. If a NODE#.BAT
  82.                          file is not found, SFAME will then check for a
  83.                          NODE.BAT file. If a NODE.BAT file is not found,
  84.                          the caller will be returned to the SFAME main
  85.                          menu. You can use NODE0.BAT for local mode. The
  86.                          NODE#.BAT or NODE.BAT can be used to run a mail
  87.                          door such as LAKOTA or any other door or menu
  88.                          extension program. When SFAME runs the NODE#.BAT
  89.                          or NODE.BAT file, it will create the same type
  90.                          of drop file used on the SFAME command line in
  91.                          the SFAME home directory. If run locally, it
  92.                          will create a SFMESS.DAT file. Leave the
  93.                          Main Menu Extension Name blank to disable.
  94.  
  95.   <E> Use Printer      - If this is set to TRUE, all log information
  96.                          will also be sent to the printer. You must
  97.                          also have SPITFIRE set to use the printer for
  98.                          this to work. You can then set this to TRUE
  99.                          and control whether the printer is used by
  100.                          changing the setting in SPITFIRE.
  101.  
  102.   <F> Inactive Timeout - This is the number of seconds of inactivity
  103.                          before the caller is returned to SPITFIRE.
  104.  
  105.   <G> Swap Memory During Shell - If this is set to TRUE then SFAME will
  106.                          remove itself from memory when the main menu
  107.                          extension is choosen, before a message upload
  108.                          or a file download.
  109.  
  110.   <H> Swap Drive/Directory - You can specify where the swap file should
  111.                          be placed. This should be a RAM drive for faster
  112.                          memory swapping. If blank, the swap file will be
  113.                          placed in the SFAME home directory.
  114.  
  115.   <I> Log File Name    - This is the file name where callers activity is
  116.                          written. You can enter CALLERS.TMP here if you
  117.                          want to use SPITFIRE's CALLERS.LOG file. If left
  118.                          blank, SFAME.LOG will be used.
  119.  
  120.   <J> Force Comments To Conference #1 - If you set this to TRUE then
  121.                          all messages to the sysop will be placed in
  122.                          group #1, conference #1.
  123.  
  124.   <K> Group Shared With SpitFire - This is the message group which shares
  125.                          its message base directory with SPITFIRE. Message
  126.                          groups will be explained later. You can set this
  127.                          to 1 for now.
  128.  
  129.   <L> File Attach Directory - This is the directory where files attached
  130.                          to messages are uploaded and stored. File
  131.                          attaches should be stored in a separate directory
  132.                          to help keep the SFAME home directory clean.
  133.  
  134.   <M> Min UL Space     - This is the minimum free disk space in KB's that
  135.                          must be available to allow a file attach upload.
  136.                          If you set this to 1000, then there must be at
  137.                          least 1MB of free disk space.
  138.  
  139.   <N> Days To Keep File Attaches - This is the number of days files that
  140.                          that are attached to messages are kept before
  141.                          deleting. If a file is older than this setting,
  142.                          it will be deleted even if the message is still
  143.                          active. This setting should be close to the
  144.                          SPITFIRE old message purge date.
  145.  
  146.   <O> Internet Address - This is your Internet domain name such as
  147.                          bbsname.com if you have one. If you don't have
  148.                          a domain name, just leave this blank. This is
  149.                          used in scripts to make the users Internet
  150.                          address for your BBS. Scripts and the users
  151.                          Internet address are explained below.
  152.  
  153.   <P> Allow Address Books - With this turned On, users will be able
  154.                          to store up to 20 addresses in their book. The
  155.                          book for each caller takes up 768 bytes. If you
  156.                          have alot of users, that could add up to alot of
  157.                          disk space.
  158.  
  159.   <R> Spell Check Security - This is the minimum security needed to use
  160.                          the spell checker. When editing a message, you
  161.                          can select <Ctrl-X> then <30> to use the spell
  162.                          checker. When you select this option, SFAME will
  163.                          first save your message to a text file. It will
  164.                          then shell to the file SPELL.BAT if it exists.
  165.                          SFAME will pass the message text file as %1.
  166.                          The SPELL.BAT file should contain the commands
  167.                          to execute your spell checker. I've included
  168.                          a sample SPELL.BAT file which uses a spell
  169.                          checker called ShareSpell. This is a good text
  170.                          based program which works well with DOORWAY. To
  171.                          get a copy, you can freq SPELL from my BBS. The
  172.                          file name for the version I have is SS24B.ZIP but
  173.                          there might be a newer version available. Any
  174.                          text based program should be able to work with
  175.                          DOORWAY. When SFAME shells to the file SPELL.BAT,
  176.                          it will create a file called DOOR.SYS which is
  177.                          used by DOORWAY. When you return to SFAME, the
  178.                          new copy of the message will be imported back
  179.                          into the SFAME editor. You can also have node
  180.                          specific SPELL#.BAT files where # is the node
  181.                          number. You should probably make a SPELL0.BAT
  182.                          for local use which doesn't contain the DOORWAY
  183.                          commands. The SPELL0.BAT can run any program
  184.                          you like. It doesn't have to be text based like
  185.                          the one used with DOORWAY.
  186.  
  187.   <S> Check for Doorway Mode - If you want SFAME to make sure the caller
  188.                          has Doorway mode before running the spell checker,
  189.                          set this to Yes. If SFAME does not detect Doorway
  190.                          mode, SFAME will not exit to the spell checker.
  191.                          If a caller tries to use the spell checker without
  192.                          Doorway mode, they probably won't be able to use
  193.                          the spell checker's commands and have to drop
  194.                          carrier to exit. If your spell checker uses
  195.                          arrow or function keys, set this to Yes.
  196.  
  197.   <T> Force Message Scan - If you want SFAME to scan for messages the first
  198.                          time the user calls each day, set this to Yes. If
  199.                          set to No, the user will be asked if they want to
  200.                          scan for new messages. This option in only used if
  201.                          you use the SCAN command line parameter.
  202.  
  203.   <Y> Make New Phonbook.Dat File - The PHONBOOK.DAT file is used to
  204.                          store the users address books. This option will
  205.                          erase the current file and create a new one. When
  206.                          you create a new file, all the address books
  207.                          from the old file will be erased.
  208.  
  209.   <Z> Make New Alias.Ptr File - The ALIAS.PTR file is used to search for
  210.                          an alias when entering a message or when choosing
  211.                          a new alias. If you erase the CALLERS.DAT file
  212.                          you will need to make a new ALIAS.PTR file.
  213.  
  214.   <Q> Quit             - Returns to the main menu.
  215.  
  216.   You can also choose F1 for help with an option while using CONFIG.
  217.  
  218.   You should next select option 2 from the main menu, Edit Message Groups.
  219.   Before setting up the message groups, I'll explain what a group is. A
  220.   group is simply a message base in its own directory consisting of the
  221.   regular SPITFIRE message data files. SPITFIRE supports 1 message base.
  222.   By using groups, you can have up to 250 message bases (groups). Each
  223.   group can consist of 784 conferences as in SPITFIRE. To use groups with
  224.   echomail, you must also use AMAIL with tags to toss the mail packets
  225.   into different directories. In your AMAIL.CFG file you should use the
  226.   SFMSGDIR option to define the directories for each group. The word
  227.   following the "=" is the TAG name for the group.
  228.   Example:
  229.  
  230.     SFMSGDIR C:\SF\MESSAGE1=GROUP1
  231.     SFMSGDIR C:\SF\MESSAGE2=GROUP2
  232.     SFMSGDIR C:\SF\MESSAGE3=GROUP3
  233.  
  234.   In your AREAS.BBS file you should have:
  235.  
  236.     !1@GROUP1 SPITFIRE
  237.     !1@GROUP2 BBS
  238.     !1@GROUP3 FREEMAIL
  239.     !2@GROUP1 CDROM
  240.  
  241.   The word following the "@" in the above lines is the TAG name for the
  242.   conference. By using the above examples, if AMAIL finds a message for
  243.   the conference SPITFIRE, it will be placed in conference 1 in the directory
  244.   C:\SF\MESSAGE1 because that is the directory specified for the tag GROUP1
  245.   in the AMAIL.CFG file. If AMAIL finds a message for the conference FREEMAIL,
  246.   it will be placed in conference 1 in the directory C:\SF\MESSAGE3. If
  247.   AMAIL finds a message for the conference CDROM, it will be placed in
  248.   conference 2 in the directory C:\SF\MESSAGE1. Your AREAS.BBS should
  249.   contain a line for each conference in each group. Read the AMAIL docs
  250.   for more information on tags and multi-base SPITFIRE setup.
  251.  
  252.   By using groups, you can place all FIDONET, SFNET or other networks
  253.   in their own group instead of having them all mixed together. You might
  254.   have to start using CONFIG and SFAME before you fully understand what
  255.   groups are. For now, just think of a group as a message base and setting
  256.   up each group is like setting up a SPITFIRE message base. When you choose
  257.   option 2, you will be asked if you would like to create the GROUPS.DAT
  258.   file. Choose YES and continue to the next menu. The screen now displays
  259.   the defaults for group 1 and a menu to change the settings. Even if you
  260.   only plan to use 1 group, you should still configure it. The options are:
  261.  
  262.   <1> Description      - This will let you change the name of the group.
  263.                          The maximum length is 40 characters.
  264.  
  265.   <2> SfMConf.dat File Name - Each group has its own SFMCONF.DAT type
  266.                          file. This should be the name of the SFMCONF.DAT
  267.                          type file for this group. You can later choose
  268.                          option 3 from the main menu to edit the message
  269.                          conferences in this file. This can also be the
  270.                          same SFMCONF.DAT file used by SPITFIRE.
  271.  
  272.   <3> Message Directory - This is the directory where the SFMSG[#].PTR,
  273.                          SFMSG[#].DAT, SFMSG[#].LMR, and SFMSG[#].IDX
  274.                          files are stored. This can be set to the same
  275.                          message directory used by SPITFIRE.
  276.  
  277.   <4> Group Security   - This is the security level needed to access this
  278.                          group.
  279.  
  280.   <5> Group Access     - Set this to E and only callers with the Group
  281.                          Security level have access. Choose G and callers
  282.                          with a security level equal to or greater than
  283.                          the Group Security have access.
  284.  
  285.   <6> Aliases          - Set this to TRUE if callers are allowed to use
  286.                          an alias in this group.
  287.  
  288.   <7> File Attaches    - Set this to TRUE if callers are allowed to
  289.                          attach files to messages in this group.
  290.  
  291.   <A> Add New Group    - Adds a new group. You can have up to 250 groups.
  292.  
  293.   <I> Insert Group     - This will insert a new group in front of the
  294.                          current one.
  295.  
  296.   <D> Delete Group     - Deletes a group. If you only have 1 group, you
  297.                          can't delete it.
  298.  
  299.   <U> Update LMR Files - If you change the maximum callers allowed on
  300.                          your BBS, choose this to rebuild the SFMSG[#].LMR
  301.                          files to the new correct size.
  302.  
  303.   <Q> Quit             - This will return you to the CONFIG main menu.
  304.  
  305.   You can also choose F1 for help with an option while using CONFIG.
  306.  
  307.   The next option on the main menu, 3 - Edit Message Conferences, will
  308.   allow you to edit the message conferences for any group. You should
  309.   choose this to setup the conferences when you start a new group. The
  310.   options for editing the message conferences are the same as used in
  311.   SPITFIRE. Refer to your SPITFIRE manual for help with a command.
  312.  
  313.   The next option on the main menu is Edit Scripts. Before explaining how
  314.   to setup the scripts, I should first explain the language and use of
  315.   scripts. Below are the script commands allowed:
  316.  
  317.   ASK - Command Line: ASK "<question>" <variable number> <max length(opt.)>
  318.         The <question> is the prompt displayed to the caller.
  319.         The <variable number> is a number 1-10 that the answer is stored in.
  320.         The <max length> is the maximum length of the answer and is optional.
  321.         Example:  ASK "What is your name: " 2 30
  322.         This would display the question, and store the answer in variable
  323.         number 2.
  324.  
  325.   DISPLAY - Command Line: DISPLAY "<text>"
  326.         This will display the <text> on the screen.
  327.  
  328.   DISPLAYANSWER - Command Line: DISPLAYANSWER "<text>" <variable number>
  329.        This display <text> followed by whatever is stored in <variable number>.
  330.  
  331.   DISPLAYFILE - Command Line: DISPLAYFILE <file name>
  332.         This will display the file <file name> if found. The <file name>
  333.         must include the dir\path if it is not in the SFAME home directory.
  334.  
  335.   GETCHOICE - Command Line: GETCHOICE "<prompt>" <choices> <variable number>
  336.         This will display <prompt> and wait for the user to enter a
  337.         character in the <choices> string. The answer will be stored in
  338.         the <variable number>.
  339.         Example: display "<C> Continue"
  340.                  display "<Q> Quit"
  341.                  GETCHOICE "Enter Selection" CQ 1
  342.         This will display the prompt and wait for the user to press
  343.         C,Q or <ENTER>. If the user pressed <ENTER> then the first
  344.         character in <choices> will be used. If they pressed enter in this
  345.         example, C will be placed in variable 1. This can be used for menus
  346.         or <Y/n> questions. You can have up to 250 choices in a menu.
  347.  
  348.   GOTO - Command Line: GOTO <label>
  349.         This is the same as the DOS batch file GOTO command. It will
  350.         search the script for <label> and continue.
  351.         Example: 
  352.           GOTO End
  353.           ...
  354.           ...
  355.           :END
  356.  
  357.   IF - Command Line: IF <variable number> <"text">
  358.         If whatever is in <variable number> equals <"text">, then
  359.         the script will continue. If it is not equal, it will search for
  360.         the next ENDIF and continue.
  361.         Example: 
  362.           IF 1 "Y"
  363.           display "Yes."
  364.           ENDIF
  365.  
  366.   WRITEANSWER - Command Line: WRITEANSWER "<text>" <variable number>
  367.         This will write <text> into the message followed by whatever
  368.         is in <variable number>.
  369.         Example: ask "What is your name: " 1 30
  370.  
  371.  WRITEANSWER "Name:" 1
  372.         This will write Name: followed by the users answer into the message.
  373.  
  374.   QUIT - Command Line: QUIT
  375.         This will quit the script and return to the editor.
  376.  
  377.   A script is a plain text file with 1 command per line. Any line
  378.   beginning with a ; is a comment that SFAME will ignore. The purpose of
  379.   the scripts is to help make it easier for callers to use some of the
  380.   services available on the Internet. Some Internet services, like
  381.   requesting files, can take commands the caller might not remember. By
  382.   using a script, you can prompt the caller for a file name, caller name
  383.   or any other information. Then the script can add the other commands,
  384.   addresses or other information needed. The variable 0 contains the users
  385.   Internet address in the form firstname.lastname@bbsname.com where
  386.   bbsname.com is replaced with your Internet address entered in the CONFIG
  387.   program. You can then use the script line:
  388.  
  389.   WRITEANSWER "Address: " 0
  390.  
  391.   This will put the text Address: followed by the users Internet address
  392.   in the message. I'm including some sample scripts in the file SCRIPTS.ZIP
  393.   to help understand how they work. Scripts can be a powerful and easy
  394.   way for your users to access features of the Internet. Scripts can
  395.   be used for other purposes than Internet features.
  396.  
  397.   When you choose option 4 to edit scripts, you will be asked if you would
  398.   like to create the SCRIPTS.DAT file. Choose YES to continue. You will
  399.   next see the list of scripts. When viewing this list, you can choose
  400.   <A> to add a new script, <D> to delete a script, or you can enter the
  401.   number of the script you would like to edit. Since the list is probably
  402.   blank, choose <A> to add a script. You will then be prompted for the
  403.   script files name. This should be the file name WITHOUT the .scr extension.
  404.   Next, you will be asked for a description for this script. You have up to
  405.   50 characters for a description. This description is displayed to the
  406.   caller when selecting a script. Next is the minimum security needed to
  407.   use this script. Next is the group number this script can be used in.
  408.   Set this to 0 if the script is available in all groups. The last prompt
  409.   asks for the conference this script can be used in. Set this to 0 if
  410.   you want to script available in all conferences. You should now see the
  411.   listing of scripts which includes the script you just added. Choose <Q>
  412.   to return to the CONFIG main menu.
  413.  
  414.   Option 5 on the main menu will allow you to setup the QWK settings used
  415.   by SFAME when making a QWK packet. The options are:
  416.  
  417.   <A> QWK Packet Name  - This is the name used for the QWK packet.
  418.                          It can be up to 8 characters and doesn't
  419.                          include the .QWK extension.
  420.  
  421.   <B> BBS Name         - This is your BBS name.
  422.  
  423.   <C> BBS City         - This is the city where your BBS is located.
  424.  
  425.   <D> BBS Phone        - This is your BBS phone number.
  426.  
  427.   <E> Max QWK Packet Size - This is the maximum number of messages that
  428.                          can be placed in a single .QWK packet. Set this
  429.                          to 0 to disable the QWK packet feature. Refer to
  430.                          the Reader section, option A below for more
  431.                          information on the QWK packets.
  432.  
  433.   <Q> Quit             - This will return you to the CONFIG main menu.
  434.  
  435.   Option 6 on the main menu will allow you to edit the files attached to
  436.   messages. This will list the files along with some other information.
  437.   If you choose D, you will be prompted for a file number to delete. If
  438.   the file is already marked DELETED, you can choose to un-delete the file.
  439.  
  440.   Option 7 will allow you to enter the nodelist information. You can specify
  441.   information for 2 nodelists which SFAME will use when you want to search
  442.   a nodelist. The options are:
  443.  
  444.   <A> Nodelist 1 Filename - This is the path\filename of the first nodelist.
  445.  
  446.   <B> Starting Position of Node Number - This is the space in the line where
  447.                          the node number begins. If this is a SFNET list,
  448.                          enter 1 here. If its a CircuitNet list, enter 1.
  449.  
  450.   <C> Node Number Length - This is the length of the node number. If this
  451.                          is a SFNET list, enter 8. It its a CircuitNet
  452.                          list, enter 6.
  453.  
  454.   <D> CircuitNet List  - If this is a CircuitNet nodelist, choose <Y>es.
  455.                          When routing a message in CircuitNet the
  456.                          address is added to the message subject. SFAME
  457.                          uses this to determine where to place the
  458.                          route-to address.
  459.  
  460.   <E>, <F>, <G>, <H>  - This is same information as above used for nodelist 2.
  461.  
  462.   <Q> Quit            - This will return you to the CONFIG main menu.
  463.  
  464.  
  465.   Option 8 on the CONFIG main menu will allow you to edit the help records
  466.   SFAME displays when you press Ctl-Z. Press A through F to edit a line in
  467.   the record. Press + or - to move between records and Q to quit. You can
  468.   also press V to see what the display will look like in SFAME. The Ctl-Z
  469.   option is available at all SFAME prompts except the ones in the editor.
  470.  
  471.   Option 9 will allow you to specify conferences which don't allow taglines
  472.   to be added to messages. Some Fidonet echos do not allow taglines to be
  473.   added to messages. Choose A to add or D to delete a conference. You can
  474.   also enter the number next to a conference to edit an existing record.
  475.   When you choose to add or edit a record, you will see a menu to set the
  476.   group and conference number for this record. Choose A to edit the group
  477.   number or B to edit the conference number. When SFAME saves a message,
  478.   it will check this file for the conference the message will be saved in.
  479.   If the group and conference are found, no tagline will be added to the
  480.   end of the message.
  481.  
  482.   Option 10 will allow you to enter up to 10 co-sysop names. Choose A to
  483.   add or D to delete a name from the list. You can also select the number
  484.   next to the name to edit the name. When a user enters a message to the
  485.   Sysop, SFAME will display the list of sysops and let the user select one.
  486.   The list of sysops is only displayed for local messages to Sysop.
  487.  
  488.   The last option on the CONFIG main menu is Q which will exit the program.
  489.  
  490.   The CONFIG program has 2 command line parameters which can be used.
  491.   They are /CLEAN and /PACKFA. The /CLEAN option will read each name in
  492.   the CALLER.DAT file and check the SFUSERS.PTR file to make sure the
  493.   caller has not been deleted. If the callers name is not found in the
  494.   SFUSERS.PTR file, it is removed from the CALLER.DAT file. The CALLER.DAT
  495.   file contains the callers configurable settings used by SFAME.
  496.  
  497.   The /PACKFA option will pack the ATTACHES.DAT of files that have been
  498.   marked deleted and files that are older than the Days To Keep File Attaches
  499.   setting. It will also delete the file if it is not attached to another
  500.   message. The /CLEAN option should be about once a week and the /PACKFA
  501.   option should probably be run everyday to help free up disk space.
  502.  
  503.   If you followed the above steps, you should now be ready to run SFAME.
  504.   To run SFAME use the command line:
  505.  
  506.     SFAME <drop file>
  507.  
  508.   The <drop file> must be SFMESS.DAT, SFMAIN.DAT, SFFILE.DAT, or SFDOORS.DAT.
  509.   You can also use the SCAN option to scan for new mail. Example:
  510.  
  511.     SFAME SFDOORS.DAT SCAN
  512.  
  513.   This will enter SFAME and start scanning for mail. You can then reply
  514.   to any messages found. The SCAN option should be used in your SFLOGON.BAT
  515.   instead of using SPITFIRE's message scan.
  516.  
  517.   If you are using SFAME locally, use the command line:
  518.  
  519.     SFAME
  520.     or
  521.     SFAME SCAN
  522.  
  523.   After the new caller screen, you should now be at the SFAME main menu.
  524.   From this menu you can choose the following options:
  525.  
  526.   <C> Change Conference - This will allow you to select a conference
  527.                          number or list available conferences.
  528.  
  529.   <D> Change Group     - This will allow you to select a group or list
  530.                          available groups.
  531.  
  532.   <L> List Messages    - This will list the messages in the current
  533.                          conference. You can use your arrow keys to
  534.                          move up/down the list and to the next/previous
  535.                          page. Press ENTER to read the message at the
  536.                          ">" cursor.
  537.  
  538.   <R> Read Messages    - This will prompt you for a message number to
  539.                          read. You can enter a message number, choose
  540.                          L to go to your last read message or press
  541.                          ENTER to list messages.
  542.  
  543.   <E> Enter Message    - This will prompt you for the conference you want
  544.                          the message saved in, who to send the message to
  545.                          and some other information. If you leave the
  546.                          Subject field blank, it will cancel the message.
  547.                          You will then see the blank editor screen where
  548.                          you enter your message. The editor commands are
  549.                          explained later.
  550.  
  551.   <A> Alter Conference Queue - This menu is the same as used by SPITFIRE.
  552.                          Refer to your SPITFIRE manual for help with the
  553.                          available options.
  554.  
  555.   <B> Alter Group Queue - This works the same as the Alter Conference Queue
  556.                          menu. All groups in your group queue will be
  557.                          scanned for new mail at logon.
  558.  
  559.   <S> Scan For Your Mail - This will scan the message base for messages
  560.                          to your name or your alias. You can also choose
  561.                          to scan for messages From you or your alias.
  562.                          SFAME will either scan all message conferences
  563.                          or just the conferences in your queue depending
  564.                          on the setting you choose in your Caller Settings.
  565.                          SFAME will stop scanning for messages when it
  566.                          reaches 200 messages found for the user. It will
  567.                          then ask if you want to read your messages now
  568.                          and sysops will be asked if they want messages
  569.                          marked Read (preview). You can stop the message
  570.                          scan by pressing any key. If you choose to read
  571.                          your messages, you will next see the reader screen
  572.                          with the message header information and a message
  573.                          displayed. Choose H to list the available options.
  574.                          Refer to the Message Reader section of this file
  575.                          for more information on the options. Choose R if
  576.                          you would like to reply to the current message.
  577.                          Refer to the Message Reader section for more
  578.                          information about replying to messages.
  579.  
  580.   <I> Change Caller Settings - This will allow the user to configure some
  581.                          of SFAME's settings. When you select I, you will
  582.                          see a listing of the current settings with a
  583.                          letter to select if you want to change a setting.
  584.                          Options A,B,C, and D will allow you to select the
  585.                          different colors SFAME will use. Set option E to
  586.                          OFF if you don't want to use color. Option F will
  587.                          allow you to select the style of borders used
  588.                          when you quote a message. Select 5 to design your 
  589.                          own quote box design. These are the macros you can
  590.                          use in your quote box:
  591.                            @F  : Replaced with the name in the From: field
  592.                                  of the message you are replying to.
  593.                            @T  : The name in the To: field.
  594.                            @Y  : Your name or alias, whichever you're using.
  595.                            @S  : The text in the Subject: field.
  596.                            @OD : The date of the original message.
  597.                            @OT : The time of the original message.
  598.                            @CD : The current date.
  599.                            @CT : The current time.
  600.  
  601.                          The @F, @T, and @Y macros are padded to fill 20
  602.                          spaces. The @S macros is padded to 25 spaces.
  603.                          Padding the text is necessary to allow your quote
  604.                          box to work with text of different lengths.
  605.                          Option G will allow you to specify if SFAME
  606.                          should scan all or your queued message conferences
  607.                          when it scans for messages. Options H and I will
  608.                          allow you to edit taglines which you can use in
  609.                          your messages. How to insert taglines is decribed
  610.                          in the Editor section. Option J will allow you to
  611.                          select an alias. The following is what SFAME checks
  612.                          when a user selects an alias:
  613.                            1. The alias can't be "SYSOP".
  614.                            2. The alias can't be the sysop's real name.
  615.                            3. The alias can't be the name of another caller.
  616.                            4. The alias can't be an alias already used by
  617.                               another user.
  618.                            5. The alias can't be used if found in the
  619.                               SPITFIRE JOKER.DAT file.
  620.                          The user will be allowed to select an alias but
  621.                          can only use it if you have the group configured
  622.                          to allow aliases. Option K lets you specify which
  623.                          method SFAME uses when listing message conferences.
  624.                          Choose 1 if you only want to display the name of
  625.                          each conference. Choose 2 if you also want to
  626.                          display the number of messages in each conference.
  627.                          Choose 3 if you want to display the number of
  628.                          new messages in each conference. Option 1 is the
  629.                          fastest and 3 is the slowest. Option L lets you
  630.                          design a quote header that will be placed above
  631.                          any text you quote when replying to a message.
  632.                          These are the macros you can include in your
  633.                          qoute header line:
  634.                            @F  : Replaced with the name in the From: field
  635.                                  of the message you are replying to.
  636.                            @FF : The First name in the From: field.
  637.                            @FL : The Last name in the From: field.
  638.                            @T  : The name in the To: field.
  639.                            @TF : The First name in the To: field.
  640.                            @TL : The Last name in the To: field.
  641.                            @Y  : Your name or alias, whichever you're using.
  642.                            @S  : The text in the Subject: field.
  643.                            @D  : The date of the original message.
  644.                            @TM : The time of the original message.
  645.  
  646.                          Example:  @F said to @T about @S on @D...
  647.                          If the original message was from Sysop to All Callers
  648.                          about SFAME written on 01-01-95 then the line placed
  649.                          above the quoted text would be:
  650.                          Sysop said to All Callers about SFAME on 01-01-95...
  651.                          You can combine text and macros to design any qoute
  652.                          header you like. You can also leave the quote header
  653.                          empty if you don't want one placed in your message.
  654.                          Option M lets you edit your address book if you have
  655.                          enabled them in the CONFIG program. You can store up
  656.                          to 20 addresses which can be used when entering a
  657.                          message.
  658.  
  659.   <H> Help Using SFAME - This will display the text file SFAME.HLP if
  660.                          found. It will also ask the user if they would
  661.                          like to download a copy. The SFAME.HLP file is
  662.                          a plain text file which you can edit. It describes
  663.                          how to use some of the features of SFAME.
  664.  
  665.   <Q> Quit             - This will return the user to SPITFIRE.
  666.  
  667.   <O> Menu Extension   - If you have entered a name for the Main Menu
  668.                          Extension in the CONFIG program, then option O
  669.                          will be displayed. SFAME will then run the
  670.                          NODE#.BAT or NODE.BAT. Refer to around line 70
  671.                          above for information on the NODE.BAT file.
  672.  
  673.   <G> Goodbye          - If you have set Main Menu Logoff to TRUE in the
  674.                          CONFIG program, this option will be shown and
  675.                          the caller will be logged off. The GOODBYE.BBS/CLR
  676.                          file will be shown if found in the SPITFIRE
  677.                          display directory.
  678.  
  679.   <F> Download QWK Packet - If the caller has selected any messages to
  680.                          be placed in a QWK packet, this will allow them
  681.                          to download it if they have enough time.
  682.  
  683.   <Ctl+Z> Help         - You can press Ctl+Z from any prompt for a help
  684.                          message describing the prompt. You can edit the
  685.                          text of the help messages in the CONFIG program.
  686.                          The Ctl+Z help is not available in the editor.
  687.  
  688.   MESSAGE READER
  689.   ──────────────
  690.  
  691.   You can read messages by choosing R or L from the main menu. After
  692.   selecting which message to read, you will then see the message information
  693.   displayed at the top of the screen and the message text below. The
  694.   header also contains 6 flags, N S T P D R, which represent the status
  695.   of each message. The N stands for a Netmail message. The S means the
  696.   message has been Sent netmail. The T means the message is Threaded to
  697.   another message. The P means this is a Private message. D stands for
  698.   Deleted and R means the message has been Received. You will also see
  699.   <First> or <Last> in the header if the current message is the first or
  700.   last message in the conference. If there is a file attached to the
  701.   message, you will see [File] displayed in the header. You should be able
  702.   to understand the rest of the information in the header. When reading
  703.   messages, you have the following options:
  704.  
  705.   <A> Add Message To QWK Packet - This will place the current message into
  706.                          a QWK packet the caller can download by choosing
  707.                          F from the Main Menu. This option will allow you
  708.                          to save a copy of the message. You can't reply
  709.                          to the messages and upload a .REP packet to SFAME.
  710.                          Since the .QWK packet does not store which group
  711.                          a message is from, SFAME would not know where to
  712.                          put the replies. The QWK packet can say the message
  713.                          is from conference #5 but if you have 2 groups, you
  714.                          will have 2 conference #5's and SFAME would not
  715.                          know where the reply belongs. You might not
  716.                          understand the above until you understand groups.
  717.                          Just remember SFAME doesn't accept .REP packets.
  718.  
  719.   <B> Edit Current Message - This will allow the user to edit a saved
  720.                          message if the message is From the user. You
  721.                          cannot edit a message that has already been received
  722.                          or sent by netmail.
  723.  
  724.   <C> Change Conference - This will allow you to select a new conference
  725.                          to read messages in. You will be prompted for the
  726.                          conference and message number to read.
  727.  
  728.   <D> Toggle Deleted   - This will toggle whether a message is deleted.
  729.  
  730.   <E> Enter Message    - This will allow you to enter a message. It will
  731.                          first ask for the conference to save the message
  732.                          in. Then SFAME will ask who to send the message
  733.                          to. If the message is not marked as NetMail, the
  734.                          To: name must be a local caller and the conference
  735.                          must be in their conference queue. You can press
  736.                          ENTER if you would like the message sent to All
  737.                          Callers. You can also send the message to * if
  738.                          you would like a copy sent to every caller. You
  739.                          can also use * 10 20 if you would like a copy
  740.                          sent to all callers with a security level of
  741.                          10 or 20.
  742.                          Examples: At the "Message To" prompt enter:
  743.                            *         to send a copy to all callers
  744.                            * 10 15   to send a copy to all callers with a
  745.                                      security level of 10 or 15.
  746.                          You can specify up to 5 security levels to send
  747.                          the message to. Only users with sysop security
  748.                          can send a message To: *. You can also enter A
  749.                          at the Message To: prompt if you want to view your
  750.                          address book. If you want to use an address stored
  751.                          in your book, enter the tag letter to the left of
  752.                          the address. Choose L from the Caller Settings menu
  753.                          to edit your address book. You must also have enabled
  754.                          the address book feature in the CONFIG program.
  755.  
  756.   <F> Follow Message Thread - This will allow you to go to the beginning
  757.                          of the message thread, or read forward or backward
  758.                          in the thread. Threaded messages are messages in
  759.                          the same conference with the same subject and
  760.                          marked as threaded.
  761.  
  762.   <G> Goto Last Message Read - This will search for the last message you've
  763.                          read in the current conference.
  764.  
  765.   <H> Help             - This will display a help screen of the message
  766.                          reader's options.
  767.  
  768.   <I> Non-Stop Capture - This will display messages non-stop. It will
  769.                          pause every 25 messages and ask if you want
  770.                          to continue. You can also press any key to stop.
  771.  
  772.   <J> Download Attached File - If there is a file attached to the current
  773.                          message, the user can download the file if they
  774.                          have enough time. If your using SFAME locally, you
  775.                          will be asked for the directory to copy the file.
  776.                          You must have DSZ.EXE or .COM in your path to
  777.                          allow downloads. The user can select X, Y, or ZModem.
  778.  
  779.   <K> Steal Tagline    - This will let you copy a tagline from the current
  780.                          message to your Taglines.txt file. When you choose
  781.                          K, you will be asked for the line number that
  782.                          contains the tagline. After you enter a number,
  783.                          you will see that line displayed and you will be
  784.                          allowed to edit the line. You can use the arrow
  785.                          keys or the home/end keys to move the cursor. 
  786.                          Press ENTER when your done editing the tagline.
  787.                          SFAME will ask if you want the line added to 
  788.                          Taglines.txt. Only users with sysop security
  789.                          can steal a tagline.
  790.  
  791.   <L> List Messages    - This will list messages available to the user.
  792.  
  793.   <M> Message Number   - This will allow you to enter a message number to
  794.                          read. You can press Enter to list messages or
  795.                          choose L for the last message you've read.
  796.  
  797.   <N> Toggle Netmail Message - This will toggle whether a message will be
  798.                          sent netmail.
  799.  
  800.   <O>, <F10> Menu Of Options - This will display the options in the message
  801.                          reader with a number you can select for each
  802.                          option. It might be easier to use the F10 menu
  803.                          instead of having to choose H - Help if you
  804.                          can't remember an option's selection letter.
  805.  
  806.   <P> Toggle Private Message - This will toggle whether a message is private.
  807.  
  808.   <Q> Quit to Main Menu - This will return you to the SFAME main menu.
  809.  
  810.   <R> Reply To Message - This will allow you to reply to the current
  811.                          message. You first will be asked where you would
  812.                          like the message saved. You will then be asked
  813.                          if you want the message sent to the To: or From:
  814.                          name. At the "Message To" prompt, enter T, F or
  815.                          press ENTER to send the message to All Callers.
  816.                          You can also enter a callers name to send the
  817.                          reply to. You can send the reply to * if you
  818.                          want a copy sent to every caller. The * is
  819.                          described in the option E help above.
  820.  
  821.   <S> Toggle NetMail Sent - This will toggle whether a netmail message
  822.                          has been sent. This option is only available
  823.                          to users with sysop security.
  824.  
  825.   <T> Text Search      - This will ask you for the text to search for and
  826.                          which message fields to search. The first message
  827.                          with the text found will be displayed.
  828.  
  829.   <U> Repeat Text Search - This will search for the next message that
  830.                          contains the text in the fields choosen with
  831.                          option T - Text Search.
  832.  
  833.   <V> View RIP Message - This will first write the current message to the
  834.                          text file VIEWRIP.RIP. If will then run the batch
  835.                          file VIEWRIP.BAT with VIEWRIP.RIP as parameter %1.
  836.                          Your VIEWRIP.BAT file should contain the line:
  837.                          <program name> %1
  838.                          Replace the <program name> with your RIP viewer
  839.                          program name. This option is only for local users.
  840.  
  841.   <W> Copy Message     - This will copy the current message to any
  842.                          conference. If a file is attached to the message,
  843.                          the information is also copied. This option is
  844.                          only available to users with sysop security.
  845.  
  846.   <X> Export Message   - This will export the current message to a text
  847.                          file or the printer. If the file already exists,
  848.                          you can append or overwrite the original. You can
  849.                          also add the header information to the copy
  850.                          exported.
  851.  
  852.   <Y> Toggle Message Read - This will toggle whether a message has been
  853.                          read or received by the message To: name.
  854.  
  855.   <Z> Move Message     - This will copy the current message to any
  856.                          conference and mark the original as deleted. If
  857.                          a file is attached to the message, the information
  858.                          is updated with the new message conference and
  859.                          number. This option is only available to users
  860.                          with sysop security.
  861.  
  862.   <[>, <]> Prev/Next Conference In Queue - Choosing [ will take you to
  863.                          the previous conference in your queue. Choosing ]
  864.                          will take you to the next conference in your queue.
  865.  
  866.   <O>+<20>             - This will let you place the To: or From: name of the
  867.                          current message in your address book. You will first
  868.                          be asked which name. You will then see your address
  869.                          book. Choose the tag letter of the entry you want to
  870.                          place this address. This option is only available by
  871.                          first selecting the <O> or <F10> menu then #20.
  872.  
  873.  
  874.   You should be able to understand the rest of the options that are listed
  875.   when choosing H in the reader. Most allow you to move between messages or
  876.   scroll the message your reading. If you are using SFAME locally, you can
  877.   also use the arrow keys, the page up/down, and home/end keys. To go to
  878.   the next message you can use either 6, +, or the right arrow. To go
  879.   to the previous message, use can use 4, -, or the left arrow. If you
  880.   are using SFAME from remote, you can use the arrow and other keys by
  881.   using DOORWAY mode. Most communication programs use ALT= to enter
  882.   doorway mode.
  883.  
  884.  
  885.   MESSAGE EDITOR
  886.   ──────────────
  887.  
  888.   When you select to enter a message, after you've entered the needed
  889.   information, you will then be at the blank editor screen. The screen
  890.   displays 20 lines of up to 74 characters each. The SFAME editor has
  891.   word-wrapping so when you reach the end of a line, SFAME will automatically
  892.   wrap the current word to the next line and you can continue typing. All
  893.   users can use the Ctrl+ key options but the Alt+ and other keys can only
  894.   be used by local users or while in DOORWAY mode. Below are the available
  895.   options when entering a message:
  896.  
  897.   <Ctrl-S> - This moves the cursor left 1 character. Local users can
  898.              also use the left arrow key.
  899.  
  900.   <Ctrl-D> - This moves the cursor right 1 character. Local users can
  901.              also use the right arrow key.
  902.  
  903.   <Ctrl-Left Arrow> - Moves to beginning of previous word.
  904.  
  905.   <Ctrl-Right Arrow> - Moves to beginning of next word.
  906.  
  907.   <Ctrl-W> - Move to Start of line. Local users can also use the HOME key.
  908.  
  909.   <Ctrl-T> - Move to End of line. Local users can also use the END key.
  910.  
  911.   <Ctrl-I> - Move to next tab stop. Local users can also use the TAB key.
  912.  
  913.   <Ctrl-E> - Move Up 1 line. Local users can also use the UP ARROW key.
  914.  
  915.   <Ctrl-O> - Move Down 1 line. Local users can also use the DOWN ARROW key.
  916.  
  917.   <Ctrl-J> - Move up 1 page. Local users can also use the PAGE UP key.
  918.  
  919.   <Ctrl-K> - Move down 1 page. Local users can also use the PAGE DOWN key.
  920.  
  921.   <Ctrl-G> - This will allow you to goto any line number in the message.
  922.  
  923.   <Ctrl-B> Block Edit  - This will allow you to move, copy or delete a
  924.                          block of text. Move the cursor to the first line
  925.                          you want in the block and press CTRL-B. You then
  926.                          can move the cursor down to the last line you
  927.                          want in the block and press CTRL-B again. You
  928.                          will then be asked if you want to move, delete,
  929.                          or copy the block. If you choose to move or copy
  930.                          the block, you will then select the line where
  931.                          you want the block placed and press ENTER.
  932.  
  933.   <Ctrl-N> - This will insert a blank line at the cursor positions line
  934.              number. If there is text on the last line, you cannot insert
  935.              a line.
  936.  
  937.   <Ctrl-Y> - This will delete the entire current line.
  938.  
  939.   <Ctrl-L> - This will insert the last line deleted using CTRL-Y. If there
  940.              is text on the last line, you cannot insert a line.
  941.  
  942.   <Ctrl-F> - This will allow you to fill the entire line with a character.
  943.              If there is text on the last line, you cannot fill a line with
  944.              characters.
  945.  
  946.   <Ctrl-R> - This will delete all text from the cursor position to the
  947.              end of the line.
  948.  
  949.   <Ctrl-H> - This is the same as using the BACKSPACE key.
  950.  
  951.   <Ctrl-C> - This will delete the character at the cursor. This is the
  952.              same as the DELETE key.
  953.  
  954.   <Ctrl-P> - This will toggle between insert and overwrite mode. This is
  955.              the same as the INSERT key.
  956.  
  957.   <Alt-D> - This will delete the word to the right of the current word.
  958.  
  959.   <Alt-H> - This will insert the name of who the message is being sent To:.
  960.  
  961.   <Alt-F> - This will insert your name in the message.
  962.  
  963.   <Alt-A> - This will toggle whether a message is public or private.
  964.  
  965.   <Alt-N> - This will allow you to change the message To: name.
  966.  
  967.   <Alt-S> - This will allow you to change the message subject.
  968.  
  969.   <Alt-K> - This will allow you to edit the routing information.
  970.  
  971.   <Alt-L> - If aliases are allowed, this will allow you to choose between
  972.             using your real name or alias for the message.
  973.  
  974.   <Alt-M> - This will allow you to edit the carbon copy list. You can have
  975.             up to 9 carbon copies. If the conference allows message routing,
  976.             you will also be asked if you would like to route the message.
  977.             You can route the original and each carbon copy to a different
  978.             address. If you want to edit one of the names in the carbon copy
  979.             list, first delete the name and re-enter it with the new
  980.             information.
  981.  
  982.   <Alt-G> - This will allow you to route this message through SFNET. If
  983.             you are replying to a message, SFAME will check the original
  984.             message for a SFNET address and ask if you want it routed there.
  985.             At the SFNET address prompt, you either enter a new address,
  986.             choose N to clear the current address or choose Q to return
  987.             to the editor and keep the current address.
  988.  
  989.   <Alt-X> - This will allow you to insert one of the taglines you entered
  990.             in the Caller Settings menu. The tagline can be any text you
  991.             often use in a message but don't want to type for every message.
  992.  
  993.   <Ctrl-Q> - If you are replying to a message, this will allow you to quote
  994.              the original. In the quote screen, you use the 2, 8 keys to
  995.              move the > up or down. You can also use the 3, 9 keys to move
  996.              up or down 1 page. If local, you can use the up/down arrows
  997.              and the pageup/down keys. If you want to quote a line, move
  998.              the > to the line and press ENTER or the SPACE bar. Press W
  999.              to toggle word wrapping on/off. When your done, choose D to
  1000.              return to the editor. If you decide not to quote the original,
  1001.              choose C to cancel the quote.
  1002.  
  1003.   <Ctrl-U> - This will allow you to upload a text file that will be placed
  1004.              in your message. The file must be uncompressed and any line
  1005.              longer than 74 characters is cut. If you are using SFAME
  1006.              locally, you can use this to import a text file into your
  1007.              message. Local users have 80 characters for the path\file name
  1008.              and remote users have 12 characters for the file name only.
  1009.              You must have DSZ.EXE or .COM somewhere in your path to allow
  1010.              uploads. The user will be able to choose X, Y, or ZModem.
  1011.              If your using SFAME locally, you can press ENTER at the
  1012.              prompt asking for a file name and SFAME will check for the
  1013.              file SFMSG.TXT in your work directory. If found, SFAME will
  1014.              insert the SFMSG.TXT file.
  1015.  
  1016.   <Ctrl-Z> - This will display the help file EDITOR.HLP. This is a plain
  1017.              text file which lists the editor commands and keys to use.
  1018.  
  1019.   <Escape> - This will exit the editor. When you select this, you will be
  1020.              asked if you want to <A>bort, <C>ontinue, or <S>ave the message.
  1021.              If you allow files attached to messages, you will also see
  1022.              an option Attach <F>ile. <A>bort will cancel the message without
  1023.              saving a copy. <C>ontinue will allow you to continue entering
  1024.              the message. <S>ave will save the message. Attach <F>ile will
  1025.              allow you to attach a file to the message. Local users will
  1026.              have 80 characters to enter a path\file name of the file to
  1027.              attach. Remote users have 12 characters for the file name.
  1028.              You must have DSZ.EXE or .COM somewhere in your path to allow
  1029.              uploads. The user will be able to choose X, Y, or ZModem.
  1030.              SFAME will check that there is at least as much free disk
  1031.              space as you specified in the CONFIG program before allowing
  1032.              an upload. When the upload is completed, the file is copied
  1033.              to the file attach directory. SFAME uses the DOS COPY command
  1034.              to copy files so you might see DOS's "1 file copied" message.
  1035.              Only 1 file can be attached to a message. You can also use
  1036.              the ESCAPE key to exit the editor.
  1037.  
  1038.   <Ctrl-A> - This will list a menu of the AutoMessage scripts available.
  1039.              If the user selects a script, any text placed into the message
  1040.              by the script will be placed at the cursor position when
  1041.              Ctrl-A was selected.
  1042.  
  1043.   <Ctrl-V> - This will show you some information about the current message.
  1044.  
  1045.   <Alt-V> - This will display a chart of the ASCII characters and codes for
  1046.             #128 through #254. The characters can be used by pressing
  1047.             ALT+ the code below the character.
  1048.  
  1049.   <Alt-B> - This will save a copy of the message to a text file. This
  1050.             option is available only to local users.
  1051.  
  1052.   <Ctrl-X>, <F10> - This will display a menu of options. You can choose
  1053.             an option by entering the number next to it. Using this menu
  1054.             is probably easier than remembering the Ctrl+ and Alt+ keys.
  1055.  
  1056.   There are a few options available only by using the F10 menu. They are:
  1057.  
  1058.   <20> - If you are replying to a message, this will check the original
  1059.          for a CircuitNet address. If an address is found, SFAME will
  1060.          add >> + the address to the message subject.
  1061.  
  1062.   <28> - This will display a menu of the SPITFIRE macros you can place
  1063.          in a message.
  1064.  
  1065.   <29> - This will allow you to search a nodelist for any text. You will
  1066.          first be asked which of the 2 nodelists to search. You then
  1067.          enter the text to search for. If you want to display the entire
  1068.          nodelist enter ALL at the prompt asking for the text to search
  1069.          for. If SFAME finds a line with the text, it will display the
  1070.          line with a tag letter. If you choose the tag letter, the address
  1071.          found on that line will be used to route the message.
  1072.  
  1073.   <30> - SFAME will shell to the file SPELL.BAT. The SPELL.BAT file is
  1074.          explained above. When you return to SFAME, you will see the editor
  1075.          screen with a new copy of your message which will contain any
  1076.          changes made in the spell checker. You can then continue to edit
  1077.          the message. You will also be asked if you want to spell check
  1078.          your message before it is saved.
  1079.  
  1080.   When saving a netmail message, first, SFAME will check for a text file
  1081.   called TAGLINES.TXT. The TAGLINES.TXT file is a plain text file which
  1082.   contains taglines that are added to messages. Place the taglines 1 per
  1083.   line and a line can't be longer than 75 characters. If you've registered
  1084.   SFAME, a tagline will be placed at the end of the message. Next, SFAME
  1085.   will check for a file called BBSNAME.DAT in your SPITFIRE work directory.
  1086.   If found, the first line will be added to the end of the message.
  1087.  
  1088.  
  1089.   SFCALLER MESSAGES
  1090.   ─────────────────
  1091.  
  1092.   SFAME supports the SPITFIRE SFCALLER message feature. Any user with
  1093.   a sysop security level can send a message to SFCALLER. A message to
  1094.   SFCALLER can be read by any caller. When a user scans for new messages,
  1095.   any messages to SFCALLER will be marked for the user to read if the
  1096.   message was written since the users last login. The name SFCALLER
  1097.   is replaced with the users name in the message header and when
  1098.   listing messages. Any user with a sysop security level will see the
  1099.   name SFCALLER in the message header instead of their actual name. This
  1100.   should help the sysop keep track of any SFCALLER messages. Only a user
  1101.   with a sysop security level can delete a message to SFCALLER. You can
  1102.   also send security specific SFCALLER messages by adding a security level
  1103.   to the SFCALLER name. A message to SFCALLER15 can only be read by users
  1104.   with a security level of 15. When entering a message in SFAME, you can
  1105.   place SFCALLER names in the carbon copy fields. This will allow you to
  1106.   send up to 10 security specific SFCALLER messages. The SFCALLER feature
  1107.   should be used instead of the SFAME message to * feature. When you send
  1108.   a SFAME message to *, it will write a message to every caller. When you
  1109.   send a message to SFCALLER, only 1 copy of the message is saved.
  1110.  
  1111.  
  1112.   SYSOP FUNCTION KEYS
  1113.   ───────────────────
  1114.  
  1115.   There are a few sysop function keys available in SFAME. They
  1116.   operate the same as in SPITFIRE.
  1117.  
  1118.   <Alt+F1> - This will log off the user and display the file
  1119.              NEEDSYS.BBS/CLR if found in your SPITFIRE display directory.
  1120.              If the file is not found, a message will be displayed.
  1121.  
  1122.   <Alt+F2> - This will log off the user without displaying a message.
  1123.  
  1124.   <Alt+C> - This will enter and exit chat mode. You can't chat with a
  1125.             caller while editing a message.
  1126.  
  1127.   <Alt+J> - This will cause SFAME to drop to dos. It will also swap out
  1128.             of memory if set in the CONFIG program. Type EXIT to return
  1129.             to SFAME.
  1130.  
  1131.   <F4> - This will toggle the printer on/off in SPITFIRE. If the SPITFIRE
  1132.          setting is OFF, then SFAME will not use the printer.
  1133.  
  1134.   <F6> - This will decrease the callers time by 5 minutes.
  1135.  
  1136.   <F7> - This will increase the callers time by 5 minutes.
  1137.  
  1138.  
  1139.   SFAME WORK FILES
  1140.   ────────────────
  1141.  
  1142.   These are the data and display files created and used by SFAME. The
  1143.   SFAME home directory refers to the directory where the SFAME.EXE and .OVR
  1144.   files are placed. SFAME uses the following SPITFIRE control characters
  1145.   when displaying files. Refer to your SPITFIRE manual if you need more
  1146.   information about the control characters. The characters can be placed
  1147.   in display files, or messages.
  1148.  
  1149.   Note: If you want to place a control character in a message using the
  1150.   SFAME editor, choose F10 for the Editor menu, then choose 28 for the
  1151.   control character menu. The reason for the extra menu is because if you
  1152.   enter ^D at the editor screen, SFAME will not know if you want to use the
  1153.   control character ^D or the editor feature ^D.
  1154.  
  1155.   Also, if you use a control character in a message, SFAME will display
  1156.   the information and not the control character. Example: If you put a ^V
  1157.   in your message, you will see your full name displayed but SFAME will
  1158.   store and save the ^V in the message. If your using SFAME locally, you
  1159.   will see the control codes. This is because of the direct screen writing
  1160.   used by SFAME.
  1161.  
  1162.           ^B (ASCII 02) - Inhibits the "More <y/n>" prompt.
  1163.           ^D (ASCII 04) - Displays caller's first name.
  1164.           ^E (ASCII 05) - Displays the subscription days left.
  1165.           ^F (ASCII 06) - Displays caller's city and state/province.
  1166.           ^J (ASCII 10) - Displays number of files uploaded by caller.
  1167.           ^K (ASCII 11) - Displays number of files downloaded by caller.
  1168.           ^L (ASCII 12) - Clears screen.
  1169.           ^O (ASCII 15) - Displays the caller's original log on date.
  1170.           ^P (ASCII 16) - Displays the "More <y/n>" prompt.
  1171.           ^Q (ASCII 17) - Displays the number of minutes allowed this log on.
  1172.           ^R (ASCII 18) - Displays the caller's phone number.
  1173.           ^S (ASCII 19) - Displays the date of the caller's last call.
  1174.           ^T (ASCII 20) - Displays the caller's password.
  1175.           ^U (ASCII 21) - Displays the caller's date of birth.
  1176.           ^V (ASCII 22) - Displays caller's full name.
  1177.           ^W (ASCII 23) - Displays the number of K uploaded.
  1178.           ^X (ASCII 24) - Displays the number of K downloaded.
  1179.           ^Y (ASCII 25) - Displays the caller's security level.
  1180.  
  1181.   The ^C, ^G, and ^N codes used by SPITFIRE are not used in SFAME.
  1182.  
  1183.   SFAME also supports the following SPITFIRE macros. While SFAME will
  1184.   correctly display the macros, you will need a version of SPITFIRE newer
  1185.   than 3.5 to use them in SPITFIRE.
  1186.  
  1187.           @PROMPTOFF@ - Inhibits the "More <y/n>" prompt.
  1188.           @FNAME@     - Displays caller's first name.
  1189.           @SUBDATE@   - Displays the subscription days left.
  1190.           @CITYSTATE@ - Displays caller's city and state/province.
  1191.           @UPLOADS@   - Displays number of files uploaded by caller.
  1192.           @DOWNLOADS@ - Displays number of files downloaded by caller.
  1193.           @CLS@       - Clears screen.
  1194.           @ORGLOG@    - Displays the caller's original log on date.
  1195.           @PROMPT@    - Displays the "More <y/n>" prompt.
  1196.           @LOGTIME@   - Displays the number of minutes allowed this log on.
  1197.           @PHONENUM@  - Displays the caller's phone number.
  1198.           @LASTCALL@  - Displays the date of the caller's last call.
  1199.           @PASSWORD@  - Displays the caller's password.
  1200.           @BIRTHDATE@ - Displays the caller's date of birth.
  1201.           @NAME@      - Displays caller's full name.
  1202.           @UPK@       - Displays the number of K uploaded.
  1203.           @DOWNK@     - Displays the number of K downloaded.
  1204.           @SLEVEL@   - Displays the caller's security level.
  1205.  
  1206.  
  1207.   EDITOR.HLP   - This is the text help displayed when you choose CTRL-Z in
  1208.                  the message editor. It is kept in the SFAME home directory.
  1209.  
  1210.   SFAME.HLP    - This is the help file displayed when you choose H from the
  1211.                  SFAME main menu. It is kept in the SFAME home directory.
  1212.  
  1213.   GROUP#.BBS/CLR - This file is displayed to the caller when they select
  1214.                    group #. Example: GROUP2.BBS/CLR will displayed when
  1215.                    a user enters group 2. This file is kept in the SFAME
  1216.                    home directory.
  1217.  
  1218.   GROUPS.BBS/CLR - This file can contain a display of the groups available.
  1219.                    When changing groups, SFAME will normally list the group
  1220.                    numbers and their description and the caller can select
  1221.                    which group to enter. By using the GROUPS.BBS/CLR screen,
  1222.                    you can create a display of the groups. SFAME allows 40
  1223.                    characters to describe a group. By using this display,
  1224.                    you can design a screen that can contain longer
  1225.                    descriptions. This file is kept in the SFAME home directory.
  1226.  
  1227.   MAINMENU.BBS/CLR - If SFAME finds this file, it will be displayed instead
  1228.                    the internal main menu. This file is kept in the SFAME
  1229.                    home directory.
  1230.  
  1231.   ATTACHES.DAT   - This file contains information about the files attached
  1232.                    to messages. Each group has its own ATTACHES.DAT file. It
  1233.                    is kept in the group directory.
  1234.  
  1235.   CALLER.DAT     - This file contains the caller settings that can be changed
  1236.                    by choosing I from the SFAME main menu. It is kept in the
  1237.                    SFAME home directory.
  1238.  
  1239.   COSYSOPS.DAT   - This file contains the names of any co-sysops you've
  1240.                    entered in the CONFIG program.
  1241.  
  1242.   GROUPS.DAT     - This file contains the setup information for each group.
  1243.                    It is kept in the SFAME home directory.
  1244.  
  1245.   NEWQUEUE.DAT   - This file is used by the SFAMEUQ.EXE utility which is
  1246.                    described later. When a user alters their message queue,
  1247.                    the new queue is written to this file. This file is written
  1248.                    to the SPITFIRE home directory.
  1249.  
  1250.   NOTAGS.DAT     - This file contains the conferences which you don't want
  1251.                    taglines used. Choose option 9 from the CONFIG menu to
  1252.                    edit the conferences in this file.
  1253.  
  1254.   SCRIPTS.DAT    - This file contains your script information. It is kept in
  1255.                    the SFAME home directory.
  1256.  
  1257.   SFAMEHLP.DAT   - This file contains the help records seen when you press
  1258.                    Ctl+Z in SFAME. You can choose menu option 8 of the CONFIG program
  1259.                    if you want to edit this file.
  1260.   
  1261.   ERRORS.LOG     - If an error occurs, it will be written to this file. If
  1262.                    this file exists, you should read it. It is used if a
  1263.                    needed file is not found or some other error occurs.
  1264.  
  1265.   SFAME.LOG      - If you don't specify a log file name in the CONFIG, SFAME
  1266.                    will write caller activity to this file. It is written
  1267.                    in the SFAME home directory.
  1268.  
  1269.   SFAME.CFG      - This is the main SFAME configuration file. It contains
  1270.                    the settings you select using the CONFIG program. It is
  1271.                    kept in the SFAME home directory.
  1272.  
  1273.   ALIAS.PTR      - This file contains all users and their alias if they use
  1274.                    one. When a caller enters SFAME, this file is scanned for
  1275.                    their settings instead of the scanning the CALLER.DAT file
  1276.                    which is slower. This file is also checked when a user
  1277.                    selects an alias. It is kept in the SFAME home directory.
  1278.  
  1279.   CONFQUE.#      - This file contains the callers conference queue for group
  1280.                    #. The file CONFQUE.2 contains the conference queues for
  1281.                    group 2. since SPITFIRE only stores 1 conference queue,
  1282.                    this allows the user to have a queue for each group. This
  1283.                    file is kept in the group directory.
  1284.  
  1285.   NODE# DIRECTORY - SFAME will create work directories called NODE# where
  1286.                     the # is the node number for the directory. Local users
  1287.                     will have a NODE0 directory. This directory is where
  1288.                     SFAME makes the .QWK packets and puts uploaded files.
  1289.                     When a user exits SFAME, this directory will be cleaned.
  1290.                     If there are some files left over after a caller, you
  1291.                     can delete them. If you create a .QWK packet locally,
  1292.                     it is kept in the NODE0 directory when you exit. The
  1293.                     NODE# directories are not removed when the user exits
  1294.                     but files in them are deleted.
  1295.  
  1296.   QWK DOORS
  1297.   ─────────
  1298.  
  1299.   You can use SFAME's Main Menu Extension to setup a QWK mail door. If
  1300.   you have more than 1 group, then your mail door will probably need a
  1301.   different configuration file for each group. Heres why. If a caller
  1302.   enters the mail door in group 1 and downloads BBSNAME.QWK, then goes
  1303.   to group 2 and uses the mail door and tries to download another packet
  1304.   called BBSNAME.QWK, the download will fail because the file already exists
  1305.   in the users DL directory. To fix this, you should include the group
  1306.   number in the QWK packet name. Group 1's name should be BBSNAME1.QWK,
  1307.   group 2's BBSNAME2.QWK, etc. Your mail door will probably need a different
  1308.   configuration file which contains the QWK packet name for each group.
  1309.   An easy way to name them is CONFIG.1, CONFIG.2, etc. When SFAME exits
  1310.   runs node.bat, it includes the group number as %1. In your node.bat
  1311.   file, you can then copy the CONFIG.%1 to the name used by your mail door.
  1312.   When a user uploads their reply packets, they will have to enter the
  1313.   mail door for each group. Using a mail door with more than 1 group
  1314.   can seem a little messy but its does work. I've included a sample
  1315.   NODE.BAT file that should help you understand this.
  1316.  
  1317.  
  1318.   MESSAGE BASE PACKING
  1319.   ────────────────────
  1320.  
  1321.   If you have more than 1 group setup, you'll need to pack the
  1322.   message conferences in each group. To do this, you'll need to make a
  1323.   SFNODE.DAT file for each group with the correct message directory.
  1324.   You should make a SFNODE.1 for group 1, SFNODE.2 for group 2, etc. for
  1325.   all groups. The SFNODE.1 will have the message directory for group 1,
  1326.   SFNODE.2 will have the message directory for group 2, etc. Below is
  1327.   an example of how to use SFPCKMSG to pack all your message groups.
  1328.  
  1329.   Example:
  1330.      CD C:\SF
  1331.      REM Save original SFMCONF.DAT
  1332.      COPY SFMCONF.DAT SFMCONF.BAK
  1333.  
  1334.      REM Save original SFNODE.DAT
  1335.      COPY SFNODE.DAT SFNODE.BAK
  1336.  
  1337.      REM Copy group #1's conference data file to C:\SF\SFMCONF.DAT
  1338.      COPY C:\SF\SFAME\SFMCONF.1 SFMCONF.DAT
  1339.  
  1340.      REM Copy group #1's SFNODE file to SFNODE.DAT
  1341.      COPY SFNODE.1 SFNODE.DAT
  1342.      SFPCKMSG /OLD=15 /POT /POU /PRM /ALL /SIZE=300
  1343.  
  1344.      REM Copy group #2's conference data file to C:\SF\SFMCONF.DAT
  1345.      COPY C:\SF\SFAME\SFMCONF.2 SFMCONF.DAT
  1346.  
  1347.      REM Copy group #2's SFNODE file to SFNODE.DAT
  1348.      COPY SFNODE.2 SFNODE.DAT
  1349.      SFPCKMSG /OLD=15 /POT /POU /PRM /ALL /SIZE=300
  1350.  
  1351.      REM Copy group #3's conference data file to C:\SF\SFMCONF.DAT
  1352.      COPY C:\SF\SFAME\SFMCONF.3 SFMCONF.DAT
  1353.  
  1354.      REM Copy group #3's SFNODE file to SFNODE.DAT
  1355.      COPY SFNODE.3 SFNODE.DAT
  1356.      SFPCKMSG /OLD=15 /POT /POU /PRM /ALL /SIZE=300
  1357.  
  1358.      REM Restore original SFMCONF.DAT
  1359.      COPY SFMCONF.BAK SFMCONF.DAT
  1360.  
  1361.      REM Restore original SFNODE.DAT
  1362.      COPY SFNODE.BAK SFNODE.DAT
  1363.  
  1364.   The above example will copy the SFMCONF.DAT and SFNODE.DAT file
  1365.   for each group and then pack the message base for that group.
  1366.  
  1367.   UTILITIES
  1368.   ─────────
  1369.  
  1370.   There are 3 other programs included with SFAME. The CONFIG program
  1371.   is described above. The TESTSCR program will test your script files
  1372.   and display a message if a problem is found in a script. To use TESTSCR,
  1373.   type TESTSCR <script name>. First, TESTSCR will read each line to make
  1374.   sure all commands are valid. It will then run the script so you can test
  1375.   the script before putting it on-line. The other program is called
  1376.   SFAMEUQ.EXE. This program will read the NEWQUEUE.DAT file and will update
  1377.   the users queue in the SFUSERS.DAT file. It should be run from your
  1378.   SFINIT.BAT file after every caller. This program is needed because when
  1379.   a caller returns from SFAME, any changes made to their conference queue
  1380.   are lost. You don't need to use SFAMEUQ if you run SFAME from the DOORS
  1381.   menu. You do need to use it if SFAME is run from a menu extension.
  1382.  
  1383.  
  1384.   FEATURES
  1385.   ────────
  1386.  
  1387.   Multi-node support
  1388.   ──────────────────
  1389.      SFAME has full file sharing and locking built in using Mike Woltz's
  1390.      BCShare. You can use the same SFAME directory and files on as many nodes
  1391.      as you like. You only need one copy of the SFAME files to handle any
  1392.      number of nodes. If you use the same copy of SFAME for all nodes, you
  1393.      must mark the files read-only or you will get DOS share errors. Go to
  1394.      the SFAME home directory and type these 2 lines:
  1395.  
  1396.        ATTRIB +R *.EXE
  1397.        ATTRIB +R *.OVR
  1398.  
  1399.  
  1400.   Multi-Tasking
  1401.   ─────────────
  1402.      SFAME supports the following multi-taskers and will release
  1403.      its time slices while idle.
  1404.  
  1405.      Windows 3.x & NT
  1406.      DESQview 2.xx
  1407.      DoubleDOS
  1408.      VMiX 2.xx
  1409.      MultiDos Plus 4.xx
  1410.      OS/2 2.0
  1411.      DOS 5.0 Task Switcher and Compatibles
  1412.      TaskView, TopView, OmniView, & Compatibles
  1413.  
  1414.   Com Ports
  1415.   ─────────
  1416.      Can use ports 1 - 8 with support for non-standard IRQs. SFAME
  1417.      uses the IRQ and com port base address information in the
  1418.      SFNODE.DAT file.
  1419.  
  1420.   Note: SFAME uses High Ascii characters for quote box types 2,3, and 4.
  1421.         Fidonet does not allow high ascii in messages so you should set
  1422.         your mail scanner to strip or convert any high ascii characters.
  1423.  
  1424.   Disclaimer
  1425.   ──────────
  1426.      Use this program at your own risk. There are no guarantees
  1427.      that SFAME will run on your system. Richard Lemaster shall
  1428.      not be held responsible for any damages incurred while running
  1429.      SFAME, CONFIG, SFAMEUQ, or TESTSCR. The user accepts all
  1430.      responsibility when using these programs.
  1431.  
  1432.  
  1433.   HELP
  1434.   ────
  1435.      If you have any questions, suggestions or problems with SFAME, you
  1436.      can leave me, Richard Lemaster, a message on my BBS or in the SFNET
  1437.      3rd Party Conference.
  1438.  
  1439.  
  1440.   REGISTRATION
  1441.   ────────────
  1442.  
  1443.      Registration for SFAME is only $15. You can pay by check or money
  1444.      order. Any checks from outside the US must be for $20 because the banks
  1445.      won't cash a foreign check under $20. So if your outside the US, its
  1446.      better to send a $15 money order.
  1447.  
  1448.      Unregistered versions of SFAME are limited to 2 groups and 1 script.
  1449.      All features work in both reg. and unregistered versions.
  1450.  
  1451.      Once registered, all future upgrades are free. You will only need the
  1452.      latest version. Your SFAME.KEY file will work with all future versions.
  1453.  
  1454.      You can either call my BBS to pick up your key or I can send it to
  1455.      you netmail if you have a Fidonet address.
  1456.  
  1457.  Information needed for registration
  1458.  ----------------------------------------------------------------------
  1459.    SFAME Registration Form
  1460.  
  1461.    BBS Name (up to 50 chars):________________________________________
  1462.  
  1463.    Sysop Name (up to 30 chars):______________________________
  1464.  
  1465.              * If your calling my BBS to pick up your key *
  1466.  
  1467.       What name will you use when calling:
  1468.  
  1469.       What password will you use when calling:
  1470.  
  1471.                * If you want it sent to you by netmail *
  1472.  
  1473.       What is your Fidonet node number:
  1474.  
  1475.  ----------------------------------------------------------------------
  1476.  To register, simply fill out the questions above and mail it and a
  1477.  check, or money order for $15 ($20 outside US) to:
  1478.  
  1479.   Richard Lemaster
  1480.   7332 So. 74 E Ave.
  1481.   Tulsa, Ok
  1482.   74133
  1483.  
  1484.  If you have any suggestions, comments, or problems with SFAME or the
  1485.  included utilities, you can leave me a message in the SFNET 3rd Party
  1486.  conference or the Fidonet Spitfire conference. The best way to contact
  1487.  me would be to call my BBS listed below.
  1488.  
  1489.   Over The Line BBS
  1490.   Richard Lemaster - Sysop
  1491.   Fidonet 1:170/260
  1492.   Line 1:(918)250-0542 28.8
  1493.   Line 2:(918)250-2462 14.4
  1494.  
  1495.  The latest version can always be FREQ'ed with the magic name "SFAME"
  1496.  from me at 1:170/260.
  1497.  
  1498.  Thanks to Jacque Shipley for helping develop and test SFAME.
  1499.  
  1500.  File sharing and locking are from BCShare by Mike Woltz.
  1501.  
  1502.   "SPITFIRE" is Copyright (C) 1987-1995 by Mike Woltz.
  1503.   "SPITFIRE" is a registered trademark of Buffalo Creek Software.
  1504.   "BCSHARE"  is Copyright (C) 1990 by Mike Woltz.
  1505.